IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks/RunIdeTask

RunIdeTask

@UntrackedTask(because = "Should always run")

abstract class RunIdeTask : JavaExec, RunnableIdeAware, CustomIntelliJPlatformVersionAware

Runs the IDE instance using the currently selected IntelliJ Platform with the built plugin loaded. It directly extends the JavaExec Gradle task, which allows for an extensive configuration (system properties, memory management, etc.).

This task class also inherits from CustomIntelliJPlatformVersionAware, which makes it possible to create runIde-like tasks using custom IntelliJ Platform versions:

import org.jetbrains.intellij.platform.gradle.IntelliJPlatformType
import org.jetbrains.intellij.platform.gradle.tasks.RunIdeTask

tasks {
  val runPhpStorm by registering(RunIdeTask::class) {
    type = IntelliJPlatformType.PhpStorm
    version = "2023.2.2"
  }

  val runLocalIde by registering(RunIdeTask::class) {
    localPath = file("/Users/hsz/Applications/Android Studio.app")
  }
}

Constructors

RunIdeTask

constructor()

Types

Companion

object Companion : Registrable

Properties

autoReload

@get:Internal

abstract val autoReload: Property<Boolean>

Enables auto-reload of dynamic plugins. Dynamic plugin will be reloaded automatically when its content is modified. This allows a much faster development cycle by avoiding a full restart of the development instance after code changes.

conventionMapping

@get:Internal

val conventionMapping: ConventionMapping

coroutinesJavaAgentFile

@get:Internal

@get:Optional

abstract val coroutinesJavaAgentFile: RegularFileProperty

The path to the coroutines Java Agent file.

enabled

@get:Internal

var enabled: Boolean

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

intelliJPlatformConfiguration

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val intelliJPlatformConfiguration: ConfigurableFileCollection

Holds the Configurations.INTELLIJ_PLATFORM configuration with the IntelliJ Platform dependency added. It should not be directly accessed.

javaLauncher

val javaLauncher: Property<JavaLauncher>

jvmArguments

val jvmArguments: ListProperty<String>

localPath

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val localPath: DirectoryProperty

An input property to define the path to the local IntelliJ Platform instance to configure the version of the custom IntelliJ Platform. The local path precedes the IntelliJ Platform resolution using the type and version properties.

mainClass

val mainClass: Property<String>

mainModule

val mainModule: Property<String>

modularity

val modularity: ModularitySpec

platformPath

@get:Internal

open val platformPath: Path

Provides access to the IntelliJ Platform dependency artifact path.

pluginXml

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

@get:Optional

abstract val pluginXml: RegularFileProperty

Holds the path to the patched plugin.xml file.

productInfo

@get:Internal

open val productInfo: ProductInfo

Provides information about the IntelliJ Platform product. The information is retrieved from the product-info.json file in the IntelliJ Platform directory.

runtimeArchitecture

@get:Internal

abstract val runtimeArchitecture: Property<String>

An architecture of the Java Runtime currently used for running Gradle.

runtimeDirectory

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val runtimeDirectory: DirectoryProperty

Java Runtime parent directory.

runtimeLauncher

@get:Internal

abstract val runtimeLauncher: Property<JavaLauncher>